home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ann34.zip / ANN.DOC < prev    next >
Text File  |  1992-12-08  |  10KB  |  240 lines
  1.  
  2.  
  3.                           The Annoncement Door!
  4.                               Version 3.40
  5.  
  6.                          (C)1991,92 T&J Software
  7.  
  8.                                 11/27/92
  9.  
  10.         One of the T&J Software Collection of multi-BBS door programs.
  11.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  12.               UltraBBS, Telegard, TriBBS, Remote Access, and WWIV
  13.  
  14.                                   by
  15.  
  16.                               T&J Software
  17.                                 T&J BBS
  18.                              (717)325-9481
  19.                                  24H/7D
  20.                               USR HST 14.4
  21.  
  22.                            397 West Broadway
  23.                           Jim Thorpe, PA 18229
  24.                           (717)325-9480 VOICE
  25.                      5:30 to 10:00 p.m. Eastern Time
  26.  
  27.  
  28. LATEST VERSION:
  29. Please call the T&J BBS for the latest version of this program.
  30.  
  31. LEGALITIES:
  32. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  33. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  34. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  35. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  36. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  37. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  38.  
  39. DISTRIBUTION:
  40. You may make this file available for downloading from your BBS or you may
  41. upload it to any BBS of your choice, provided that you do not make any
  42. changes to the contents of the archive (ZIP file). The archive and its
  43. individual contents may not be used by any service that charges any money
  44. whatsoever, without the written permission of the author.
  45.  
  46. PROGRAM DESCRIPTION:
  47. My users contribute to registering door programs. I made this simple
  48. door as a way for all users to see who payed to have each door
  49. registered. There is no fee for this door.
  50.  
  51. You can also use it as a COMMENT FROM THE SYSOP about the door that
  52. the person is entering.
  53.  
  54. To try the door locally simply run ANN LOCAL.
  55.  
  56.  
  57. NOTE: When making your ANNOUNCE.ANS and your ANNOUNCE.ASC screens using
  58.       your drawing package, try leaving the top three lines and bottom
  59.       three lines blank. Also, when saving your screen be sure not to
  60.       include a clear screen command. Save the screen with a "home cursor".
  61.       If you are using TheDraw greater than version 3.3 use a "block save"
  62.       to save your screen.
  63.  
  64. CONFIGURATION: (ANN.CFG)
  65. =============
  66.  
  67. Example configuration file for PCBOARD.SYS
  68. ------------------------------------------
  69.  
  70. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  71. T&J Software        <=-  (Change this to your BBS name)
  72. Tom                 <=-  (The Sysop's first name)
  73. Wildoner            <=-  (The Sysop's last name)
  74.  
  75. Example configuration file for USERS.SYS
  76. ----------------------------------------
  77.  
  78. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  79. T&J Software        <=-  (Change this to your BBS name)
  80. Tom                 <=-  (The Sysop's first name)
  81. Wildoner            <=-  (The Sysop's last name)
  82.  
  83. Example configuration file for DOOR.SYS
  84. ---------------------------------------
  85.  
  86. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  87. T&J Software        <=-  (Change this to your BBS name)
  88. Tom                 <=-  (The Sysop's first name)
  89. Wildoner            <=-  (The Sysop's last name)
  90.  
  91. Example configuration file for USERINFO.DAT
  92. -------------------------------------------
  93.  
  94. C:\BBS\USERINFO.DAT <=-  (Full pathname of your USERINFO.DAT file)
  95. T&J Software        <=-  (Change this to your BBS name)
  96. Tom                 <=-  (The Sysop's first name)
  97. Wildoner            <=-  (The Sysop's last name)
  98. NOTE: DOOR.SYS must be in the SAME directory as USERINFO.DAT
  99.  
  100. Example configuration file for CALLINFO.BBS
  101. -------------------------------------------
  102.  
  103. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  104. T&J Software        <=-  (Change this to your BBS name)
  105. Tom                 <=-  (The Sysop's first name)
  106. Wildoner            <=-  (The Sysop's last name)
  107.  
  108. Example configuration file for DORINFOx.DEF
  109. -------------------------------------------
  110.  
  111. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  112.                           where 'x' is the BBS Node number.
  113. T&J Software        <=-  (Change this to your BBS name)
  114. Tom                 <=-  (The Sysop's first name)
  115. Wildoner            <=-  (The Sysop's last name)
  116.  
  117. Example configuration file for SFDOORS.DAT
  118. ------------------------------------------
  119.  
  120. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  121. T&J Software        <=-  (Change this to your BBS name)
  122. Tom                 <=-  (The Sysop's first name)
  123. Wildoner            <=-  (The Sysop's last name)
  124.  
  125. Example configuration file for CHAIN.TXT
  126. ----------------------------------------
  127.  
  128. C:\BBS\CHAIN.TXT    <=-  (Full pathname of your CHAIN.TXT file)
  129. T&J Software        <=-  (Change this to your BBS name)
  130. Tom                 <=-  (The Sysop's first name)
  131. Wildoner            <=-  (The Sysop's last name)
  132.  
  133. Example configuration file for GTUSER.BBS
  134. -----------------------------------------
  135.  
  136. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  137. T&J Software        <=-  (Change this to your BBS name)
  138. Tom                 <=-  (The Sysop's first name)
  139. Wildoner            <=-  (The Sysop's last name)
  140. 1                   <=-  (COM port number - defaults to 1)
  141. 1                   <=-  (Node number - defaults to 1)
  142.  
  143. Example Batch File
  144. ==================
  145.  
  146. A sample batch file is included and is similer to the following:
  147.    ECHO OFF
  148.    CD\DOORS\LEMON           <=- Switch to the door's Directory.
  149.    ANN ANN.CFG              <=- Execute Announce!
  150.    LEMON33 LEMON.CFG        <=- Execute the door program and pass the
  151.                                 configuration filename to the program.
  152.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  153.    BOARD                    <=- Restart BBS.
  154.  
  155. This Door is multi-node  compatible so you may run more than 1 node from
  156. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  157. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  158. variables, (q.v.)
  159.  
  160. Environment Variables
  161. =====================
  162.  
  163. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  164. variables. Non-PCBoard systems may also use these variables by including
  165. the following in either your BBS batch or AUTOEXEC.BAT
  166.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  167.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  168. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  169. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  170. .CFG file for multi-node operation!
  171.  
  172. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  173. command line.  For example:
  174.  
  175.      ANN ANN.CFG /5
  176. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  177.      ANN ANN.CFG /%IRQ%
  178.  
  179. This tells the program to use IRQ 5 instead of the standard IRQ.
  180.  
  181.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  182.  systems. Seems Novell also uses the / character so something went screwy
  183.  somewhere. So I added the * (asterisk) which may be used instead of the /
  184.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  185.  and are interchangeable.
  186.  
  187. When specifying the location of the system file on line 1 of the doors .CFG
  188. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  189. and %wcnodeid%. Some examples:
  190.  PCBoard: 
  191.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  192.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  193.  
  194.  Wildcat!:
  195.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  196.  
  197. Non-PCBoard systems may use the PCB environment variables by setting them
  198. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  199.  SET PCBDRIVE=C:
  200.  SET PCBDIR=\BBSDIR
  201.  SET PCBNODE=1
  202.  
  203. Fossil Driver Support
  204. ---------------------
  205. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  206. Fossil driver instead of the standard COM ports, just put /FD on the command
  207. line when running the door. For example:
  208.      MYDOOR MYDOOR.CFG /FD
  209. indicates that a Fossil driver is present and should be used. If no Fossil
  210. driver is detected, DoorFrame will print a message to that effect and exit
  211. the door gracefully.
  212.  
  213.  
  214. Sysop Keys
  215. ==========
  216.  
  217. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  218.          written to DOOR.SYS and USERS.SYS
  219. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  220.          and/or written to DOOR.SYS and USERS.SYS
  221. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  222. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  223.          and/or written to DOOR.SYS and USERS.SYS
  224. F8    -  Returns the caller involuntarily to the BBS.
  225. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  226.          and/or written to DOOR.SYS and USERS.SYS
  227. F10   -  Activates SysOp CHAT mode within the DOOR.
  228. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  229. UP    -  Give the caller extra time while in the DOOR.  
  230. DN    -  Subtract time from the caller while in the DOOR. 
  231. HOME  -  HELP key for Status Line options.
  232. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  233. ALT-X -  PCBoard will exit after current caller logs off. Value is
  234.          passed to PCBoard. Not available on non-PCBoard systems.
  235.  
  236. If you have any problems/suggestions please feel free to contact The
  237. T&J BBS.
  238.  
  239. See the REGISTER.TXT file for other programs from T&J Software!
  240.